Interface PtpProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
PtpProcessImpl

public interface PtpProcess extends Process
Information provided by the PKI file:

    \class CPTPProcess
    \This class holds PTPProcess declaration.
    \example network().getDevice("Switch0").getProcess("CPTPProcess")
    
Author:
Auto-generated
  • Method Details

    • getT1

      long getT1()
      Information provided by the PKI file:
      
          \brief Returns the T1 value.
          
          \return long, the T1 value.
          
              
      Returns:
      long Returns a long
    • getT2

      long getT2()
      Information provided by the PKI file:
      
          \brief Returns the T2 value.
          
          \return long, the T2 value.
          
              
      Returns:
      long Returns a long
    • getT3

      long getT3()
      Information provided by the PKI file:
      
          \brief Returns the T3 value.
          
          \return long, the T3 value.
          
              
      Returns:
      long Returns a long
    • getT4

      long getT4()
      Information provided by the PKI file:
      
          \brief Returns the T4 value.
          
          \return long, the T4 value.
          
              
      Returns:
      long Returns a long
    • setT1

      void setT1(long t)
      Information provided by the PKI file:
      
          \brief Sets the T1 value.
          
          \param t, the T1 value to use.
          
              
      Parameters:
      t - Takes in a parameter of t
    • setT2

      void setT2(long t)
      Information provided by the PKI file:
      
          \brief Sets the T2 value.
          
          \param t, the T2 value to use.
          
              
      Parameters:
      t - Takes in a parameter of t
    • setT3

      void setT3(long t)
      Information provided by the PKI file:
      
          \brief Sets the T3 value.
          
          \param t, the T3 value to use.
          
              
      Parameters:
      t - Takes in a parameter of t
    • setT4

      void setT4(long t)
      Information provided by the PKI file:
      
          \brief Sets the T4 value.
          
          \param t, the T4 value to use.
          
              
      Parameters:
      t - Takes in a parameter of t
    • setPtpDebugEventFlag

      void setPtpDebugEventFlag(boolean flag)
      Information provided by the PKI file:
      
          \brief Sets debug event flag for ptp.
          
          \param flag, true to enable debug, false to disable.
          
              
      Parameters:
      flag - Takes in a parameter of flag
    • getPtpDebugEventFlag

      boolean getPtpDebugEventFlag()
      Information provided by the PKI file:
      
          \brief Gets debug event flag for ptp.
          
          \return bool, true if debug enabled, false if disabled.
          
              
      Returns:
      boolean Returns a boolean
    • setPtpDebugMsgFlag

      void setPtpDebugMsgFlag(boolean flag)
      Information provided by the PKI file:
      
          \brief Sets debug message flag for ptp.
          
          \param flag, value to use for the flag.
          
              
      Parameters:
      flag - Takes in a parameter of flag
    • getPtpDebugMsgFlag

      boolean getPtpDebugMsgFlag()
      Information provided by the PKI file:
      
          \brief Gets debug message flag for ptp.
          
          \param return, value is the flag value.
          
              
      Returns:
      boolean Returns a boolean
    • syncToCurrentTime

      void syncToCurrentTime()
      Information provided by the PKI file:
      
          \brief Syncs the time to the current time.
          
              
    • runBMC

      void runBMC()
      Information provided by the PKI file:
      
          \brief Runs BMC (best master clock).